/*
 * Copyright (c) 2010, Jim Hollinger
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Jim Hollinger nor the names of its contributors
 *     may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef COMMON_DATACHANNEL_DATACHANNELFACTORY_H_
#define COMMON_DATACHANNEL_DATACHANNELFACTORY_H_

#include <string>

namespace logger {
    class Logger;
};

namespace datachannel {

class DataChannel;

/**
 ****************************************************************************
 * @brief  A class to instanciate the appropriate data channel.
 ****************************************************************************
**/
class DataChannelFactory {
  public:
    static DataChannel *getInstance(const std::string &descriptor,
                                    logger::Logger *logger);
    static bool unitTest();

  protected:
    DataChannelFactory() {}
    ~DataChannelFactory() {}
    DataChannelFactory(const DataChannelFactory &);
    DataChannelFactory & operator=(const DataChannelFactory &);
    static bool unitTest(const std::string &inDescriptor,
                         const std::string &outDescriptor,
                         const std::string &text,
                         logger::Logger *logger);

  public:
    static const std::string FILE_DESCRIPTOR;
    static const std::string PCAP_DESCRIPTOR;
    static const std::string SOCKET_DESCRIPTOR;
    static const std::string RAW_SOCKET_ATTRIBUTE;
};

}  // namespace datachannel

#endif  // COMMON_DATACHANNEL_DATACHANNELFACTORY_H_
